| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

ImageView.h
1 // ImageView.h
3 //
5
6 namespace nkImages
7 {
13 class ImageView final : public ImageBase
14 {
15 public :
16
20 ImageView () noexcept = delete ;
26 ImageView (const Image& image) noexcept ;
32 ImageView (const nkMemory::BufferView<unsigned char>& dataView) noexcept ;
45 ImageView (const nkMemory::BufferView<unsigned char> dataView, unsigned int width, unsigned int height, unsigned int depth, PIXEL_FORMAT format, unsigned int pixelOrBlockByteSize = 0, unsigned int rowByteSize = 0, unsigned int sliceByteSize = 0) noexcept ;
60 ImageView (const nkMemory::BufferView<unsigned char> dataView, unsigned int width, unsigned int height, unsigned int depth, unsigned int arraySize, unsigned int mips, PIXEL_FORMAT format, unsigned int pixelOrBlockByteSize = 0) noexcept ;
67 ImageView (const ImageView& other) noexcept ;
74 ImageView (const ImageView& other, unsigned int slice) noexcept ;
82 ImageView (const ImageView& other, unsigned int slice, unsigned int mip) noexcept ;
88 ImageView (ImageView&& other) noexcept ;
92 virtual ~ImageView () ;
93
94 // Data access
95 virtual unsigned char* getDataPtr () const override ;
96 virtual unsigned long long getDataByteSize () const override ;
97 virtual nkMemory::BufferView<> getDataBuffer () const override ;
98 virtual bool isView () const override ;
99
100 // Operators
106 ImageView& operator= (const ImageView& other) noexcept ;
112 ImageView& operator= (ImageView&& other) noexcept ;
113 } ;
114 }
nkImages::ImageView::getDataPtr
virtual unsigned char * getDataPtr() const override
nkImages::ImageView
Holds all information required for an image, with no ownership over the data.
Definition: ImageView.h:14
nkImages::ImageView::getDataBuffer
virtual nkMemory::BufferView getDataBuffer() const override
nkImages::ImageBase
Base for all image data classes.
Definition: ImageBase.h:19
nkImages
Encompasses all API of component NilkinsImages.
Definition: BmpEncoder.h:7
nkImages::PIXEL_FORMAT
PIXEL_FORMAT
Lists formats for pixels.
Definition: PixelFormat.h:16
nkImages::ImageView::getDataByteSize
virtual unsigned long long getDataByteSize() const override
nkImages::ImageView::isView
virtual bool isView() const override
nkImages::ImageView::ImageView
ImageView() noexcept=delete
nkImages::Image
Holds all information required for an image, with ownership over the data.
Definition: Image.h:14
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7